docs: Improve Javadoc for HostAndPortMapper (#4112) #4227

JuneYub · 2025-08-09T20:01:03Z

Improves Javadoc as requested in #4112.
The wiki is deprecated, so I've focused on the code-level documentation.

ggivo · 2025-08-11T11:54:45Z

Improves Javadoc as requested in #4112. The wiki is deprecated, so I've focused on the code-level documentation.

Deprecation goes for "Release Notes" section itself.

My idea is to use the wiki as a dev-friendly doc with more code examples.
Once we have the example wrapped up, we can also consider adding some of them to the official doc.
I suggest adding a coding example under the https://github.com/redis/jedis/wiki/AdvancedUsage section.

cc: @andy-stark-redis

PS: @JuneYub forgot to say, Hi and thanks for the involvement!

JuneYub · 2025-08-11T13:51:16Z

@ggivo

Hello, thank you for the review.
I've realized that a documentation update is needed to reflect the changes in this PR. Specifically, it seems the AdvancedUsage.md page in the Wiki should be updated.
Since I don't seem to have direct permission to edit the Wiki, I'd like to ask for the best way to propose the documentation changes.
Should I leave the proposed content here as a comment in this PR?
Please let me know the preferred method for the project, and I will proceed accordingly.
Thank you.

ggivo · 2025-08-11T16:35:31Z

@JuneYub
Ahh.. My bad, wikis are quite outdated. I meant to update https://redis.github.io/jedis/
You can update directly advanced-usage.md and add it to the review,

You can take a look at docs/README.md how to generate docs locally, then advanced-usage should be available at http://0.0.0.0:8000/advanced-usage/

Hope it helps...

JuneYub · 2025-08-12T14:49:11Z

Hi @ggivo,

Thanks for the feedback!

I have added the documentation for HostAndPortMapper to advanced-usage.md as you requested.

To help users better understand its usage, I've included examples for both implementing it with a dedicated class and using a more concise lambda expression, especially since it's a functional interface.

Please take a look when you have a moment. I'm open to any further suggestions.

Thanks!

ggivo · 2025-08-13T06:54:47Z

@JuneYub
Looks good overall!

However, as part of our ongoing effort to simplify the API, we’re aiming to reduce the number of public constructors and promote the single constructor that accepts a JedisClientConfig. This approach centralizes multiple connection parameters into a single object (see here) and is the recommended way forward.
I suggest examples provided to be based on DefaultJedisClientConfig (see here) or based on JedisClientConfig (see here) directly.

…edis#4112)

JuneYub · 2025-08-13T14:39:37Z

@ggivo
Thanks for the clarification! Updated the docs to use DefaultJedisClientConfig as suggested.
Learned a better approach for simplifying constructor usage.

Copilot

Pull Request Overview

This PR improves the documentation for the HostAndPortMapper interface as requested in issue #4112. The changes focus on enhancing code-level documentation since the wiki is deprecated.

Added comprehensive Javadoc comments to the HostAndPortMapper interface
Added detailed documentation section in advanced-usage.md explaining the purpose and usage of HostAndPortMapper
Provided practical examples showing both class-based and lambda-based implementations

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
src/main/java/redis/clients/jedis/HostAndPortMapper.java	Added interface-level Javadoc and method documentation with `@FunctionalInterface` annotation
docs/advanced-usage.md	Added comprehensive documentation section with examples for NAT/containerization scenarios

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

docs/advanced-usage.md

ggivo · 2025-08-14T06:57:40Z

@JuneYub
Merged. Thanks for the amazing work.

| Package | Type | Package file | Manager | Update | Change | |---|---|---|---|---|---| | [redis.clients:jedis](https://github.com/redis/jedis) | dependencies | misk/gradle/libs.versions.toml | gradle | minor | `6.1.0` -> `6.2.0` | | [com.google.cloud:google-cloud-spanner](https://github.com/googleapis/java-spanner) | dependencies | misk/gradle/libs.versions.toml | gradle | minor | `6.98.1` -> `6.99.0` | --- ### Release Notes <details> <summary>redis/jedis (redis.clients:jedis)</summary> ### [`v6.2.0`](https://github.com/redis/jedis/releases/tag/v6.2.0): 6.2.0 ### Changes #### 🚀 New Features - \[vector sets] Support for VSIM WITHATTRIBS (CAE-1421) ([#4260](redis/jedis#4260)) - Support Redis 8 vector sets [#4169](redis/jedis#4169) ([#4203](redis/jedis#4203)) #### 🐛 Bug Fixes - Fix JedisBroadcastException in functionLoadReplace for Redis Cluster ([#4219](redis/jedis#4219)) #### 🧰 Maintenance - Bump org.apache.maven.plugins:maven-javadoc-plugin from 3.11.2 to 3.11.3 ([#4246](redis/jedis#4246)) - Bump org.junit:junit-bom from 5.13.3 to 5.13.4 ([#4216](redis/jedis#4216)) - docs: Improve Javadoc for HostAndPortMapper ([#4112](redis/jedis#4112)) ([#4227](redis/jedis#4227)) #### Contributors We'd like to thank all the contributors who worked on this release! [@JuneYub](https://github.com/JuneYub), [@Kguswo](https://github.com/Kguswo), [@dependabot](https://github.com/dependabot), [@dependabot](https://github.com/dependabot)\[bot] and [@ggivo](https://github.com/ggivo) </details> <details> <summary>googleapis/java-spanner (com.google.cloud:google-cloud-spanner)</summary> ### [`v6.99.0`](https://github.com/googleapis/java-spanner/blob/HEAD/CHANGELOG.md#6990-2025-08-26) ##### Features - Support read lock mode for R/W transactions ([#4010](googleapis/java-spanner#4010)) ([7d752d6](googleapis/java-spanner@7d752d6)) ##### Bug Fixes - **deps:** Update the Java code generator (gapic-generator-java) to 2.62.0 ([52c68db](googleapis/java-spanner@52c68db)) - GetCommitResponse() should return error if tx has not committed ([#4021](googleapis/java-spanner#4021)) ([a2c179f](googleapis/java-spanner@a2c179f)) ##### Dependencies - Update dependency com.google.cloud:sdk-platform-java-config to v3.52.0 ([#4024](googleapis/java-spanner#4024)) ([7e3294f](googleapis/java-spanner@7e3294f)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 6pm every weekday,before 2am every weekday" in timezone Australia/Melbourne, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Never, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). GitOrigin-RevId: 9d031eaaab2d726402884bd41681c856931f12f0

docs: Improve Javadoc for HostAndPortMapper (redis#4112)

069ea6f

docs: Improve Javadoc for HostAndPortMapper (redis#4112)

b35a510

JuneYub and others added 2 commits August 13, 2025 23:25

Merge branch 'master' into docs/clarify-hostandportmapper-usage

2c0d5c8

docs: update HostAndPortMapper usage to use DefaultJedisClientConfig (r…

0f58ec6

…edis#4112)

ggivo previously approved these changes Aug 14, 2025

View reviewed changes

ggivo requested a review from Copilot August 14, 2025 05:02

Copilot AI reviewed Aug 14, 2025

View reviewed changes

docs/advanced-usage.md Outdated Show resolved Hide resolved

docs: update HostAndMapper advanced-usage.md

75c16af

JuneYub dismissed ggivo’s stale review via 75c16af August 14, 2025 05:13

docs: add example use case

049d6df

ggivo added the documentation label Aug 14, 2025

ggivo added this to the 6.2.0 milestone Aug 14, 2025

ggivo previously approved these changes Aug 14, 2025

View reviewed changes

update wordlist

e7183ec

ggivo dismissed their stale review via e7183ec August 14, 2025 06:01

ggivo approved these changes Aug 14, 2025

View reviewed changes

Merge branch 'master' into docs/clarify-hostandportmapper-usage

911b858

ggivo merged commit 9312acc into redis:master Aug 14, 2025
10 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: Improve Javadoc for HostAndPortMapper (#4112) #4227

docs: Improve Javadoc for HostAndPortMapper (#4112) #4227

Uh oh!

JuneYub commented Aug 9, 2025 •

edited by ggivo

Loading

Uh oh!

ggivo commented Aug 11, 2025 •

edited

Loading

Uh oh!

JuneYub commented Aug 11, 2025

Uh oh!

ggivo commented Aug 11, 2025 •

edited

Loading

Uh oh!

JuneYub commented Aug 12, 2025 •

edited

Loading

Uh oh!

ggivo commented Aug 13, 2025

Uh oh!

JuneYub commented Aug 13, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

ggivo commented Aug 14, 2025

Uh oh!

Uh oh!

docs: Improve Javadoc for HostAndPortMapper (#4112) #4227

docs: Improve Javadoc for HostAndPortMapper (#4112) #4227

Uh oh!

Conversation

JuneYub commented Aug 9, 2025 • edited by ggivo Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ggivo commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JuneYub commented Aug 11, 2025

Uh oh!

ggivo commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JuneYub commented Aug 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ggivo commented Aug 13, 2025

Uh oh!

JuneYub commented Aug 13, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

ggivo commented Aug 14, 2025

Uh oh!

Uh oh!

JuneYub commented Aug 9, 2025 •

edited by ggivo

Loading

ggivo commented Aug 11, 2025 •

edited

Loading

ggivo commented Aug 11, 2025 •

edited

Loading

JuneYub commented Aug 12, 2025 •

edited

Loading